Support existing Sphinx sites and the Klink theme - #150
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Contributor
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #150 +/- ##
==========================================
+ Coverage 85.48% 86.18% +0.69%
==========================================
Files 15 16 +1
Lines 1936 2019 +83
Branches 204 209 +5
==========================================
+ Hits 1655 1740 +85
- Misses 216 217 +1
+ Partials 65 62 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add an optional source-dir for existing Sphinx documentation trees. Preserve source documents and navigation instead of generating an index from a README; resolve static and extra assets relative to that source directory.
Register Klink, including releases without a Sphinx theme entry point, and provide plain-text page titles for that theme. Add configurable intersphinx inventories and a warning-is-error CLI option. Write CNAME into the selected output directory.
This enables bt to replace its manual Sphinx/Klink deployment with Yardang while retaining its reStructuredText pages, URLs, saved notebook exports, and styling.
Verified 100 tests, make lint, and a real bt documentation build with warnings treated as errors. Browser checks cover styling, API anchors, and search.
Type of Change
Checklist
make lint)make test)Version unchanged; release separately after review.